'.\" t
.TH "cllocks.xml" "1M" "Jun 30, 2005" "1\&.0\&.0"
.SH NAME
cllocks.xml \- Linuxha.net Lock Daemon Config File

.SH SYNOPSIS
Definition of Linuxha.net Lock Daemon Config File

The lock daemon provides facilities to ensure that 
multiple processes access cluster resources in a 
well defined way to ensure no conflicts in resource
allocation.

The daemon has a built-in list of locks, but it is
recommended that a suitable XML configuration file
is available as /etc/cluster/cllocks.xml instead so
the administrator is explicitly aware of the locks
and the associated properties.

The following is a copy of a suitable cllocks.xml
file (which must exist on both nodes):

.TS
l.
<?xml version="1.0" standalone="yes"?>
<cllocks>
        <lock name="NET"
              desc="Network Config"
              maxt="40"
        />
        <lock name="NBD_CLIENT"
              desc="DRBD Primary Access"
              maxt="45"
        />
        <lock name="NBD_SERVER"
              desc="DRBD Secondary Access"
              maxt="45"
        />
</cllocks>
.TE

.SH FILE FORMAT
The XML file has a single top-level "cllocks" element, which
contains one or more "lock" elements, each defining a lock.

Each "lock" element has no data, but instead must define three
attributes:

.TP 6
.B name
The name of the lock - must not contain white space and obviously be
unique, but has no other restrictions.
.TP
.B desc
A very short (2-5 words) description of the lock.
.TP
.B maxt
The maximum time the lock can be held before it is made
available to other callers/programs.
.RE
.RS 7

Currently Linuxha.net programs expect the following locks to exist, and
if they do not problems may result:

.TP 12
.B NET
When network changes are required, such as allocation of a virtual
IP address a "NET" lock is typically acquired first.
.TP
.B NBD_CLIENT
Ensures that only a single DRBD client setup program runs at once.
.TP
.B NBD_SERVER
Ensures that only a single DRBD server (remote host) setup program runs 
at once.

.SH SEE ALSO
.TS
l l.
cllockd(1M)	- Linuxha.net lock daemon
appconf.xml(5)	- Configuration of an application used by the cluster
clconf.xml(5)	- Cluster configuration file format
.TE

.SH AVAILABILITY
This software is freely available from the Linuxha.net website - please see
http://linuxha.net/index.pl?ARGS=findproject:linuxha for more details.

.SH WARRANTY
This is Open Source Software is per the GNU GPL. It is free to use and
distribute but \fIcomes with no warranty whatsoever\fP. For more information
on the license please see \fBwww.gnu.org/copyleft/gpl.html\fP.

